<!-- HTML header for doxygen 1.8.7-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
        <meta http-equiv="X-UA-Compatible" content="IE=9"/>
		<meta name="robots" content="noindex, follow"/>
        <meta name="generator" content="Doxygen 1.8.20"/>
        <title>PositionalTrackingParameters Class Reference | API Reference | Stereolabs</title><!--END PROJECT_NAME (ZED csharp API)-->
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nunito+Sans:300,400,500,600,700,800">
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono:300,400,500,600,700">
        <link href="tabs.css?t=Wed Jan 27 2021 13:57:23" rel="stylesheet" type="text/css"/>
        <script type="text/javascript" src="jquery.js?t=Wed Jan 27 2021 13:57:23"></script>
        <script type="text/javascript" src="custom.js?t=Wed Jan 27 2021 13:57:23"></script>
        <script type="text/javascript" src="dynsections.js?t=Wed Jan 27 2021 13:57:23"></script>
        <link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
        <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
        <link href="stylesheet.css?t=Wed Jan 27 2021 13:57:23" rel="stylesheet" type="text/css" />
    </head>
    <body>
        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
            <div id="titlearea">
                <table cellspacing="0" cellpadding="0">
                    <tbody>
                        <tr style="height: 58px;">
                            <td class="headerSpacer"></td>
                            <td id="projectlogo">
                                <a href="https://www.stereolabs.com"><img src="https://www.stereolabs.com/img/logo_stereolabs.svg" alt="Stereolabs logo" id="logo"></a>
                            </td>
                            <td class="nav-links nav-links-header">
                                <a href="https://www.stereolabs.com/docs/" >DOCUMENTATION</a>
                            </td>
                            <td class="nav-links nav-links-header">
                                <a href="https://www.stereolabs.com/docs/code-samples/" >SAMPLES</a>
                            </td>
                            <td class="nav-links nav-links-header">
                                <a class="active" href="https://www.stereolabs.com/developers/documentation/API/latest/" >API REFERENCE</a>
                            </td>
                            <td class="nav-links nav-links-header">
                                <a href="https://support.stereolabs.com/hc/en-us" >SUPPORT</a>
                            </td>
                            <td class="nav-links nav-links-header">
                                <a href="https://www.stereolabs.com/developers/release/latest/" >DOWNLOADS</a>
                            </td>
                            <td><i class="mobile-navigation"></i></td>
                            <!--<td id="projectlogo" >
                                <a href="https://www.stereolabs.com/"> <img alt="Logo" src="logo_stereolabs.png" height="27"/> </a>
                            </td>-->
                            <!--<td style="padding-left: 0.4cm;">-->
                                <!--<div id="projectname">--><!--ZED csharp API-->
                                    <!--<span id="projectnumber"> | ZED SDK 3.3.0</span>-->
                                <!--</div>-->
                                <!--BEGIN PROJECT_BRIEF<div id="projectbrief"></div><!--END PROJECT_BRIEF-->
                            <!--</td>-->
                            <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.svg"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
                        </tr>
                    </tbody>
                </table>
            </div>
            <div id="subtitlearea">
                <table cellspacing="0" cellpadding="0">
                    <tbody>
                        <tr style="height: 28px;">
                            <td class="headerSpacer"></td>
                            <td id="subMenuCpp" class="nav-links nav-links-header nav-links-selected">
                                <a href="https://www.stereolabs.com/docs/api/"  >C++</a>
                            </td>
                            <td id="subMenuPython" class="nav-links nav-links-header">
                                <a href="https://www.stereolabs.com/docs/api/python/" >Python</a>
                            </td>
		                        <td id="subMenuCSharp" class="nav-links nav-links-header">
                                <a href="https://www.stereolabs.com/docs/api/csharp/" >C#</a>
                            </td>
                        </tr>
                    </tbody>
                </table>
            </div>
            <!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classsl_1_1PositionalTrackingParameters.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classsl_1_1PositionalTrackingParameters-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PositionalTrackingParameters Class Reference<div class="ingroups"><a class="el" href="group__PositionalTracking__group.html">Positional Tracking Module</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Parameters for positional tracking initialization.  
 <a href="classsl_1_1PositionalTrackingParameters.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for PositionalTrackingParameters:</div>
<div class="dyncontent">
<div class="center"><!-- SVG 0 -->
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a52aab7a6d47e0c20ffafc5fbea307d93"><td class="memItemLeft" align="right" valign="top">Quaternion&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsl_1_1PositionalTrackingParameters.html#a52aab7a6d47e0c20ffafc5fbea307d93">initialWorldRotation</a> = Quaternion.Identity</td></tr>
<tr class="memdesc:a52aab7a6d47e0c20ffafc5fbea307d93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotation of the camera in the world frame when the camera is started.By default, it should be identity.  <a href="classsl_1_1PositionalTrackingParameters.html#a52aab7a6d47e0c20ffafc5fbea307d93">More...</a><br /></td></tr>
<tr class="separator:a52aab7a6d47e0c20ffafc5fbea307d93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addd15277352a856f0695119fcf84540f"><td class="memItemLeft" align="right" valign="top">Vector3&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsl_1_1PositionalTrackingParameters.html#addd15277352a856f0695119fcf84540f">initialWorldPosition</a> = Vector3.Zero</td></tr>
<tr class="memdesc:addd15277352a856f0695119fcf84540f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Position of the camera in the world frame when the camera is started. By default, it should be zero.  <a href="classsl_1_1PositionalTrackingParameters.html#addd15277352a856f0695119fcf84540f">More...</a><br /></td></tr>
<tr class="separator:addd15277352a856f0695119fcf84540f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18a0926b98dcc6fbbe3cc0698be43000"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsl_1_1PositionalTrackingParameters.html#a18a0926b98dcc6fbbe3cc0698be43000">enableAreaMemory</a> = true</td></tr>
<tr class="memdesc:a18a0926b98dcc6fbbe3cc0698be43000"><td class="mdescLeft">&#160;</td><td class="mdescRight">This mode enables the camera to remember its surroundings. This helps correct positional tracking drift, and can be helpful for positioning different cameras relative to one other in space.  <a href="classsl_1_1PositionalTrackingParameters.html#a18a0926b98dcc6fbbe3cc0698be43000">More...</a><br /></td></tr>
<tr class="separator:a18a0926b98dcc6fbbe3cc0698be43000"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af52540c9d245ec3b5f8aafa8d70e2670"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsl_1_1PositionalTrackingParameters.html#af52540c9d245ec3b5f8aafa8d70e2670">enablePoseSmothing</a> = false</td></tr>
<tr class="memdesc:af52540c9d245ec3b5f8aafa8d70e2670"><td class="mdescLeft">&#160;</td><td class="mdescRight">This mode enables smooth pose correction for small drift correction.  <a href="classsl_1_1PositionalTrackingParameters.html#af52540c9d245ec3b5f8aafa8d70e2670">More...</a><br /></td></tr>
<tr class="separator:af52540c9d245ec3b5f8aafa8d70e2670"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae14672c74025feead4569837c9388277"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsl_1_1PositionalTrackingParameters.html#ae14672c74025feead4569837c9388277">setFloorAsOrigin</a> = false</td></tr>
<tr class="memdesc:ae14672c74025feead4569837c9388277"><td class="mdescLeft">&#160;</td><td class="mdescRight">This mode initializes the tracking to be aligned with the floor plane to better position the camera in space.  <a href="classsl_1_1PositionalTrackingParameters.html#ae14672c74025feead4569837c9388277">More...</a><br /></td></tr>
<tr class="separator:ae14672c74025feead4569837c9388277"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a684a15650f076aabed930eddb25406b6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsl_1_1PositionalTrackingParameters.html#a684a15650f076aabed930eddb25406b6">setAsStatic</a> = false</td></tr>
<tr class="memdesc:a684a15650f076aabed930eddb25406b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This setting allows you define the camera as static. If true, it will not move in the environment. This allows you to set its position using initial_world_transform.  <a href="classsl_1_1PositionalTrackingParameters.html#a684a15650f076aabed930eddb25406b6">More...</a><br /></td></tr>
<tr class="separator:a684a15650f076aabed930eddb25406b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ffb04709d76a13aa013ff5f1756ecc0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsl_1_1PositionalTrackingParameters.html#a7ffb04709d76a13aa013ff5f1756ecc0">enableIMUFusion</a> = true</td></tr>
<tr class="memdesc:a7ffb04709d76a13aa013ff5f1756ecc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This setting allows you to enable or disable IMU fusion. When set to false, only the optical odometry will be used.  <a href="classsl_1_1PositionalTrackingParameters.html#a7ffb04709d76a13aa013ff5f1756ecc0">More...</a><br /></td></tr>
<tr class="separator:a7ffb04709d76a13aa013ff5f1756ecc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e86f21f2e3d9cd18a51844549507ca3"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsl_1_1PositionalTrackingParameters.html#a5e86f21f2e3d9cd18a51844549507ca3">areaFilePath</a> = &quot;&quot;</td></tr>
<tr class="memdesc:a5e86f21f2e3d9cd18a51844549507ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Area localization file that describes the surroundings, saved from a previous tracking session.  <a href="classsl_1_1PositionalTrackingParameters.html#a5e86f21f2e3d9cd18a51844549507ca3">More...</a><br /></td></tr>
<tr class="separator:a5e86f21f2e3d9cd18a51844549507ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parameters for positional tracking initialization. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a52aab7a6d47e0c20ffafc5fbea307d93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52aab7a6d47e0c20ffafc5fbea307d93">&#9670;&nbsp;</a></span>initialWorldRotation</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Quaternion initialWorldRotation = Quaternion.Identity</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Rotation of the camera in the world frame when the camera is started.By default, it should be identity. </p>

</div>
</div>
<a id="addd15277352a856f0695119fcf84540f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addd15277352a856f0695119fcf84540f">&#9670;&nbsp;</a></span>initialWorldPosition</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Vector3 initialWorldPosition = Vector3.Zero</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Position of the camera in the world frame when the camera is started. By default, it should be zero. </p>

</div>
</div>
<a id="a18a0926b98dcc6fbbe3cc0698be43000"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18a0926b98dcc6fbbe3cc0698be43000">&#9670;&nbsp;</a></span>enableAreaMemory</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool enableAreaMemory = true</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This mode enables the camera to remember its surroundings. This helps correct positional tracking drift, and can be helpful for positioning different cameras relative to one other in space. </p>

</div>
</div>
<a id="af52540c9d245ec3b5f8aafa8d70e2670"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af52540c9d245ec3b5f8aafa8d70e2670">&#9670;&nbsp;</a></span>enablePoseSmothing</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool enablePoseSmothing = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This mode enables smooth pose correction for small drift correction. </p>

</div>
</div>
<a id="ae14672c74025feead4569837c9388277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae14672c74025feead4569837c9388277">&#9670;&nbsp;</a></span>setFloorAsOrigin</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool setFloorAsOrigin = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This mode initializes the tracking to be aligned with the floor plane to better position the camera in space. </p>

</div>
</div>
<a id="a684a15650f076aabed930eddb25406b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a684a15650f076aabed930eddb25406b6">&#9670;&nbsp;</a></span>setAsStatic</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool setAsStatic = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This setting allows you define the camera as static. If true, it will not move in the environment. This allows you to set its position using initial_world_transform. </p>

</div>
</div>
<a id="a7ffb04709d76a13aa013ff5f1756ecc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ffb04709d76a13aa013ff5f1756ecc0">&#9670;&nbsp;</a></span>enableIMUFusion</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool enableIMUFusion = true</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This setting allows you to enable or disable IMU fusion. When set to false, only the optical odometry will be used. </p>

</div>
</div>
<a id="a5e86f21f2e3d9cd18a51844549507ca3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e86f21f2e3d9cd18a51844549507ca3">&#9670;&nbsp;</a></span>areaFilePath</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string areaFilePath = &quot;&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Area localization file that describes the surroundings, saved from a previous tracking session. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
